Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(http): Refresh headers docs (d-k) #36075

Merged
merged 17 commits into from
Nov 18, 2024
Merged

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented Sep 27, 2024

Description

This PR refreshes a few HTTP headers pages.

common changes:

  • Improve See also
  • Capitalize Yes/No in properties table
  • Normalize The HTTP **`Header-Name`** (request|response) header in first sentence
  • Add status text to HTTPStatus macros, e.g. {{HTTPStatus("406", "406 Not Acceptable")}}
  • Remove improper use of quotes in and around code
  • Avoid escaping angle brackets in directive names in favor of backticks:
- \<directive>
+ `<directive>`

Motivation

Keeping content up-to-date, fixing formatting, unifying writing conventions

Related pull requests:

@bsmth bsmth requested a review from a team as a code owner September 27, 2024 09:17
@bsmth bsmth requested review from Elchi3 and removed request for a team September 27, 2024 09:17
@github-actions github-actions bot added Content:HTTP HTTP docs size/l [PR only] 501-1000 LoC changed labels Sep 27, 2024
Copy link
Contributor

github-actions bot commented Sep 27, 2024

Preview URLs (24 pages)
Flaws (1)

Note! 23 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/HTTP/Headers/Digest
Title: Digest
Flaw count: 1

  • bad_bcd_queries:
    • No BCD data for query: http.headers.Digest
External URLs (8)

URL: /en-US/docs/Web/HTTP/Headers/Expect-CT
Title: Expect-CT


URL: /en-US/docs/Web/HTTP/Headers/Keep-Alive
Title: Keep-Alive


URL: /en-US/docs/Web/HTTP/Headers/DPR
Title: DPR


URL: /en-US/docs/Web/HTTP/Headers/Early-Data
Title: Early-Data


URL: /en-US/docs/Web/HTTP/Headers/If-None-Match
Title: If-None-Match

(comment last updated: 2024-11-18 23:03:06)

@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label Oct 24, 2024
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@Elchi3 Elchi3 removed their request for review October 28, 2024 12:41
@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Oct 29, 2024
@bsmth bsmth requested a review from a team as a code owner October 29, 2024 17:04
@bsmth bsmth requested review from hamishwillee and removed request for a team October 29, 2024 17:04
@github-actions github-actions bot added the Content:Glossary Glossary entries label Oct 29, 2024
@github-actions github-actions bot added the Content:Meta Content in the meta docs label Nov 18, 2024
@bsmth
Copy link
Member Author

bsmth commented Nov 18, 2024

Thanks Hamish, I think I got everything in 3e6ccdd if you want another look 👀

## Examples

Note that we use the plural "Examples" even if the page only contains one example.

### A descriptive heading

Each example must have an H3 heading (`###`) naming the example. The heading should be descriptive of what the example is doing. For example, "A simple example" does not say anything about the example and therefore, not a good heading. The heading should be concise. For a longer description, use the paragraph after the heading.
Each example **must** have an H3 heading (`###`) naming the example. The heading should be descriptive of what the example is doing. For example, "A simple example" does not say anything about the example and therefore, not a good heading. The heading should be concise. For a longer description, use the paragraph after the heading.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW we wouldn't use "a simple example" anyway, because what is simple to one is not simple to others.

But I would use "Basic example" meaning "shows the core example usage".

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noice! Thanks very much.

@hamishwillee hamishwillee merged commit edefa50 into mdn:main Nov 18, 2024
8 checks passed
@bsmth bsmth deleted the http-headers-d branch November 19, 2024 08:29
@bsmth
Copy link
Member Author

bsmth commented Nov 19, 2024

Great! Thanks a lot 🙏🏻

wbamberg added a commit to wbamberg/content that referenced this pull request Nov 27, 2024
* origin/xss-guide: (284 commits)
  Add information on default entryPoint property values (mdn#36633)
  Bump husky from 9.1.6 to 9.1.7 (mdn#36863)
  fix(performance): Typo '50ms seconds' (mdn#36861)
  Add spec_url & add note for bcd for `<frequency>` and `<frequency-percentage>` (mdn#36848)
  addresses 36583: summary icon styles (mdn#36691)
  Remove "simple" part 3: change to "basic"  (mdn#36762)
  the default option of a select (mdn#36658)
  docs(css): Add support for `<string>` in `syntax` descriptor of @Property at-rule (mdn#36655)
  Fix parameter syntax for `Navigation.updateCurrentEntry()` (mdn#36852)
  Update CSP source expression reference (mdn#36792)
  chore(http): Refresh headers docs (d-k) (mdn#36075)
  chore(http): Refresh headers r-s (mdn#36590)
  Updated index.md (mdn#36845)
  fix : wrong method name (mdn#36843)
  Remove all redirects to other locales (mdn#36811)
  fix typos (mdn#36837)
  docs: update Accept-Charset status (mdn#36822)
  updateSelection: make more intuitive (mdn#36834)
  updateText: Remove false information (mdn#36832)
  DOMRect instance properties (mdn#36704)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Glossary Glossary entries Content:HTTP HTTP docs Content:Meta Content in the meta docs size/l [PR only] 501-1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants